Skip to content

[Enhancement] aws_api_gateway_integration: Add response_transfer_mode argument for response streaming #45329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[Enhancement] aws_api_gateway_integration: Add response_transfer_mode argument for response streaming #45329

wants to merge 4 commits into from
+119 −0

Conversation

@tabito-hara
Copy link
Contributor

@tabito-hara tabito-hara commented Dec 1, 2025

Rollback Plan

If a change needs to be reverted, we will publish an updated version of the library.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

Description

This PR adds the response_transfer_mode argument to the aws_api_gateway_integration resource.

  • Patch operations for updating response_transfer_mode follow the behavior described in the AWS documentation.
  • This argument is marked as Computed.
    • If the Read API returns an empty value for response_transfer_mode, it is set to the default value BUFFERED.
    • Because it is marked as both Optional and Computed, no diff occurs when the user does not configure this argument.
    • Documentation clarifies that once this value is set, configuring it to BUFFERED requires explicitly specifying BUFFERED, rather than removing the argument.

Relations

Closes #45168
Closes #45322

References

https://docs.aws.amazon.com/apigateway/latest/api/API_PutIntegration.html#apigw-PutIntegration-request-responseTransferMode
https://docs.aws.amazon.com/apigateway/latest/developerguide/response-streaming-http.html

Output from Acceptance Testing

$ make testacc TESTS='TestAccAPIGatewayIntegration_' PKG=apigateway 
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
make: Running acceptance tests on branch: 🌿 f-aws_api_gateway_integration-add_response_transfer_mode 🌿...
TF_ACC=1 go1.24.10 test ./internal/service/apigateway/... -v -count 1 -parallel 20 -run='TestAccAPIGatewayIntegration_'  -timeout 360m -vet=off
2025/12/01 19:48:03 Creating Terraform AWS Provider (SDKv2-style)...
2025/12/01 19:48:03 Initializing Terraform AWS Provider (SDKv2-style)...
=== RUN   TestAccAPIGatewayIntegration_basic
=== PAUSE TestAccAPIGatewayIntegration_basic
=== RUN   TestAccAPIGatewayIntegration_contentHandling
=== PAUSE TestAccAPIGatewayIntegration_contentHandling
=== RUN   TestAccAPIGatewayIntegration_Parameters_cacheKey
=== PAUSE TestAccAPIGatewayIntegration_Parameters_cacheKey
=== RUN   TestAccAPIGatewayIntegration_Parameters_cacheKeyUpdate
=== PAUSE TestAccAPIGatewayIntegration_Parameters_cacheKeyUpdate
=== RUN   TestAccAPIGatewayIntegration_Parameters_requestUpdate
=== PAUSE TestAccAPIGatewayIntegration_Parameters_requestUpdate
=== RUN   TestAccAPIGatewayIntegration_Parameters_requestCacheKeyUpdate
=== PAUSE TestAccAPIGatewayIntegration_Parameters_requestCacheKeyUpdate
=== RUN   TestAccAPIGatewayIntegration_integrationType
=== PAUSE TestAccAPIGatewayIntegration_integrationType
=== RUN   TestAccAPIGatewayIntegration_TLS_insecureSkipVerification
=== PAUSE TestAccAPIGatewayIntegration_TLS_insecureSkipVerification
=== RUN   TestAccAPIGatewayIntegration_responseTransferMode
=== PAUSE TestAccAPIGatewayIntegration_responseTransferMode
=== RUN   TestAccAPIGatewayIntegration_disappears
=== PAUSE TestAccAPIGatewayIntegration_disappears
=== CONT  TestAccAPIGatewayIntegration_basic
=== CONT  TestAccAPIGatewayIntegration_Parameters_requestCacheKeyUpdate
=== CONT  TestAccAPIGatewayIntegration_Parameters_cacheKeyUpdate
=== CONT  TestAccAPIGatewayIntegration_responseTransferMode
=== CONT  TestAccAPIGatewayIntegration_Parameters_cacheKey
=== CONT  TestAccAPIGatewayIntegration_contentHandling
=== CONT  TestAccAPIGatewayIntegration_Parameters_requestUpdate
=== CONT  TestAccAPIGatewayIntegration_TLS_insecureSkipVerification
=== CONT  TestAccAPIGatewayIntegration_integrationType
=== CONT  TestAccAPIGatewayIntegration_disappears
--- PASS: TestAccAPIGatewayIntegration_disappears (30.23s)
--- PASS: TestAccAPIGatewayIntegration_Parameters_requestUpdate (61.12s)
--- PASS: TestAccAPIGatewayIntegration_responseTransferMode (91.55s)
--- PASS: TestAccAPIGatewayIntegration_basic (106.06s)
--- PASS: TestAccAPIGatewayIntegration_Parameters_requestCacheKeyUpdate (150.14s)
--- PASS: TestAccAPIGatewayIntegration_Parameters_cacheKey (229.16s)
--- PASS: TestAccAPIGatewayIntegration_contentHandling (230.51s)
--- PASS: TestAccAPIGatewayIntegration_TLS_insecureSkipVerification (422.11s)
--- PASS: TestAccAPIGatewayIntegration_Parameters_cacheKeyUpdate (497.97s)
--- PASS: TestAccAPIGatewayIntegration_integrationType (748.18s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/apigateway 752.683s

@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

Community Guidelines

This comment is added to every new Pull Request to provide quick reference to how the Terraform AWS Provider is maintained. Please review the information below, and thank you for contributing to the community that keeps the provider thriving! 🚀

Voting for Prioritization

  • Please vote on this Pull Request by adding a 👍 reaction to the original post to help the community and maintainers prioritize it.
  • Please see our prioritization guide for additional information on how the maintainers handle prioritization.
  • Please do not leave +1 or other comments that do not add relevant new information or questions; they generate extra noise for others following the Pull Request and do not help prioritize the request.

Pull Request Authors

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added needs-triage Waiting for first response or review from a maintainer. documentation Introduces or discusses updates to documentation. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure. service/apigateway Issues and PRs that pertain to the apigateway service. size/M Managed by automation to categorize the size of a PR. labels Dec 1, 2025
@tabito-hara tabito-hara changed the title F aws api gateway integration add response transfer mode [Enhancement] aws_api_gateway_integration: Add response_transfer_mode argument for response streaming Dec 1, 2025
@github-actions github-actions bot added the size/L Managed by automation to categorize the size of a PR. label Dec 1, 2025
@tabito-hara tabito-hara force-pushed the f-aws_api_gateway_integration-add_response_transfer_mode branch from 3d594a1 to 046c196 Compare December 1, 2025 11:32
@tabito-hara tabito-hara force-pushed the f-aws_api_gateway_integration-add_response_transfer_mode branch from 046c196 to f44a73a Compare December 1, 2025 11:34
@tabito-hara tabito-hara marked this pull request as ready for review December 1, 2025 12:20
@tabito-hara tabito-hara requested a review from a team as a code owner December 1, 2025 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Introduces or discusses updates to documentation. needs-triage Waiting for first response or review from a maintainer. service/apigateway Issues and PRs that pertain to the apigateway service. size/L Managed by automation to categorize the size of a PR. size/M Managed by automation to categorize the size of a PR. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add support for REST API Gateway streaming API Gateway response streaming

1 participant

@tabito-hara